lteiot19.h File Reference

This file contains API for LTE IoT 19 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	lteiot19_t
	LTE IoT 19 Click context object. More...
struct	lteiot19_cfg_t
	LTE IoT 19 Click configuration object. More...

Macros
#define	LTEIOT19_CMD_SWITCH_DATA_TO_CMD   "+++"
	LTE IoT 19 control commands.
#define	LTEIOT19_CMD_AT   "AT"
#define	LTEIOT19_CMD_GET_MODEL_ID   "AT+CGMM"
#define	LTEIOT19_CMD_GET_SW_VERSION   "AT+CGMR"
#define	LTEIOT19_CMD_GET_SERIAL_NUM   "AT+CGSN"
#define	LTEIOT19_CMD_FACTORY_RESET   "AT&F"
#define	LTEIOT19_CMD_SW_RESET   "ATZ"
#define	LTEIOT19_CMD_SET_UE_FUNCTIONALITY   "AT+CFUN"
#define	LTEIOT19_CMD_NETWORK_REGISTRATION   "AT+CEREG"
#define	LTEIOT19_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
#define	LTEIOT19_CMD_OPERATOR_SELECTION   "AT+COPS"
#define	LTEIOT19_CMD_SEND_SMS   "AT+CMGS"
#define	LTEIOT19_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
#define	LTEIOT19_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
#define	LTEIOT19_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
#define	LTEIOT19_CMD_TCP_OPEN_SOCKET   "AT+KTCPCFG"
#define	LTEIOT19_CMD_TCP_START_CONNECTION   "AT+KTCPCNX"
#define	LTEIOT19_CMD_TCP_RECEIVE_DATA   "AT+KTCPRCV"
#define	LTEIOT19_CMD_TCP_SEND_DATA   "AT+KTCPSND"
#define	LTEIOT19_CMD_TCP_CLOSE_SOCKET   "AT+KTCPCLOSE"
#define	LTEIOT19_CMD_TCP_DELETE_SOCKET   "AT+KTCPDEL"
#define	LTEIOT19_CMD_UDP_OPEN_SOCKET   "AT+KUDPCFG"
#define	LTEIOT19_CMD_UDP_RECEIVE_DATA   "AT+KUDPRCV"
#define	LTEIOT19_CMD_UDP_SEND_DATA   "AT+KUDPSND"
#define	LTEIOT19_CMD_UDP_CLOSE_SOCKET   "AT+KUDPCLOSE"
#define	LTEIOT19_CMD_GNSS_START   "AT+GNSSSTART"
#define	LTEIOT19_CMD_GNSS_STOP   "AT+GNSSSTOP"
#define	LTEIOT19_CMD_GNSS_REPORT   "AT+GNSSLOC"
#define	LTEIOT19_RSP_OK   "OK"
	LTE IoT 19 device response for AT commands.
#define	LTEIOT19_RSP_ERROR   "ERROR"
#define	LTEIOT19_RSP_CONNECT   "CONNECT"
#define	LTEIOT19_MAX_RSP_TIME_DEFAULT   2000ul
	LTE IoT 19 device response time for AT commands.
#define	LTEIOT19_MAX_RSP_TIME_COPS   120000ul
#define	LTEIOT19_MAX_RSP_TIME_CFUN   120000ul
#define	LTEIOT19_MAX_RSP_TIME_CMGS   30000ul
#define	LTEIOT19_MAX_RSP_TIME_CGDCONT   5000ul
#define	LTEIOT19_MAX_RSP_TIME_TCP_START   30000ul
#define	LTEIOT19_MAX_RSP_TIME_TCP_DATA   60000ul
#define	LTEIOT19_MAX_RSP_TIME_TCP_CLOSE   60000ul
#define	LTEIOT19_MAX_RSP_TIME_UDP_DATA   60000ul
#define	LTEIOT19_MAX_RSP_TIME_UDP_CLOSE   60000ul
#define	LTEIOT19_MAX_RSP_TIME_URC   30000ul
#define	LTEIOT19_URC_TCP_SOCKET   "+KTCPCFG: "
	LTE IoT 19 device unsolicited response code (URC) settings.
#define	LTEIOT19_URC_TCP_DATA   "+KTCP_DATA: "
#define	LTEIOT19_URC_TCP_STATUS   "+KTCP_IND: "
#define	LTEIOT19_URC_UDP_SOCKET   "+KUDPCFG: "
#define	LTEIOT19_URC_UDP_DATA   "+KUDP_DATA: "
#define	LTEIOT19_URC_UDP_STATUS   "+KUDP_IND: "
#define	LTEIOT19_URC_NETWORK_REGISTERED   "+CEREG: 2,1"
#define	LTEIOT19_URC_SMS_FORMAT_PDU   "+CMGF: 0"
#define	LTEIOT19_URC_SMS_FORMAT_TXT   "+CMGF: 1"
#define	LTEIOT19_POWER_STATE_OFF   0
	LTE IoT 19 power state settings.
#define	LTEIOT19_POWER_STATE_ON   1
#define	LTEIOT19_POWER_STATE_RESET   2
#define	LTEIOT19_POWER_STATE_WAKEUP   3
#define	LTEIOT19_TX_DRV_BUFFER_SIZE   256
	LTE IoT 19 driver buffer size.
#define	LTEIOT19_RX_DRV_BUFFER_SIZE   256
#define	LTEIOT19_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	lteiot19_return_value_t { LTEIOT19_OK = 0 , LTEIOT19_ERROR = -1 , LTEIOT19_ERROR_TIMEOUT = -2 , LTEIOT19_ERROR_CMD = -3 }
	LTE IoT 19 Click return value data. More...

Functions
void	lteiot19_cfg_setup (lteiot19_cfg_t *cfg)
	LTE IoT 19 configuration object setup function.
err_t	lteiot19_init (lteiot19_t *ctx, lteiot19_cfg_t *cfg)
	LTE IoT 19 initialization function.
err_t	lteiot19_generic_write (lteiot19_t *ctx, uint8_t *data_in, uint16_t len)
	LTE IoT 19 data writing function.
err_t	lteiot19_generic_read (lteiot19_t *ctx, uint8_t *data_out, uint16_t len)
	LTE IoT 19 data reading function.
void	lteiot19_set_wup_pin (lteiot19_t *ctx, uint8_t state)
	LTE IoT 19 set WUP pin function.
void	lteiot19_set_rst_pin (lteiot19_t *ctx, uint8_t state)
	LTE IoT 19 set RST pin function.
void	lteiot19_set_rts_pin (lteiot19_t *ctx, uint8_t state)
	LTE IoT 19 set RTS pin function.
uint8_t	lteiot19_get_ring_pin (lteiot19_t *ctx)
	LTE IoT 19 get RING pin function.
uint8_t	lteiot19_get_rts_pin (lteiot19_t *ctx)
	LTE IoT 19 get CTS pin function.
void	lteiot19_set_power_state (lteiot19_t *ctx, uint8_t state)
	LTE IoT 19 set power state function.
void	lteiot19_cmd_run (lteiot19_t *ctx, uint8_t *cmd)
	LTE IoT 19 cmd run function.
void	lteiot19_cmd_set (lteiot19_t *ctx, uint8_t *cmd, uint8_t *value)
	LTE IoT 19 cmd set function.
void	lteiot19_cmd_get (lteiot19_t *ctx, uint8_t *cmd)
	LTE IoT 19 cmd get function.
void	lteiot19_cmd_help (lteiot19_t *ctx, uint8_t *cmd)
	LTE IoT 19 cmd help function.
void	lteiot19_set_sim_apn (lteiot19_t *ctx, uint8_t *sim_apn)
	LTE IoT 19 set sim card APN function.
void	lteiot19_send_sms_text (lteiot19_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 19 send SMS in text mode function.
err_t	lteiot19_send_sms_pdu (lteiot19_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 19 send SMS in PDU mode function.

Detailed Description

This file contains API for LTE IoT 19 Click Driver.

Enumeration Type Documentation

lteiot19_return_value_t

enum lteiot19_return_value_t

LTE IoT 19 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT19_OK
LTEIOT19_ERROR
LTEIOT19_ERROR_TIMEOUT
LTEIOT19_ERROR_CMD